// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-07-25

package logics

import (
	"context"
	"gitee.com/go-libs/result"
	"github.com/kataras/iris/v12"
)

type (
	// Logical
	// is a required method used to run logic process.
	Logical interface {
		Run(ctx context.Context, i iris.Context) result.Result
	}

	// LogicalAfter
	// is an optional hook use to repair response result if implemented.
	LogicalAfter interface {
		After(ctx context.Context, i iris.Context, res result.Result)
	}

	// LogicalBefore
	// is an optional hook used to validate request body if implemented.
	// Skip logical runner hook and chained hooks if error returned.
	LogicalBefore interface {
		Before(ctx context.Context, i iris.Context) (err error)
	}

	// LogicalReleaser
	// is an optional hook used to release Logical instance to pool if
	// implemented.
	LogicalReleaser interface {
		Release()
	}

	LogicalClassName interface {
		SetClassName(name string)
	}
)
